home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / pcbpag31.zip / PCBPAGE.DOC < prev    next >
Text File  |  1991-12-07  |  12KB  |  362 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.                                 PCBPage Door
  22.  
  23.               A Seamless Page Door Interface for PCBoard 14.5a
  24.                    A Good Page Door for all BBS Systems.
  25.  
  26.                        Version 3.1, December 7, 1991
  27.  
  28.  
  29.  
  30.  
  31.                              By: Lance Williams
  32.                                P. O. Box 266
  33.                               Camden, NY 13316
  34.  
  35.                              BBS: Kadet PCBoard
  36.                                (315) 245-3815
  37.                            USR Dual Std. HST/V.32
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.         PCBPage Door                                              Page 1
  63.  
  64.  
  65.     License Agreement
  66.  
  67.             The PCBPage Door ("The Software") is COPYRIGHT 1991 by Lance
  68.     Williams, ALL RIGHTS RESERVED.
  69.  
  70.             You  may not engage in,  nor permit third  parties to engage
  71.     in, any of the following :
  72.  
  73.             A)   Making alterations of any kind in the software.
  74.  
  75.             B)   ATTEMPTING TO DISASSEMBLE,  DECOMPILE, OR  REVERSE
  76.                  ENGINEER THE SOFTWARE OR THE FILES IT GENERATES IN ANY
  77.                  WAY.
  78.  
  79.             C)   Granting  sub-licenses, lease  or other  rights in the
  80.                  software to others.
  81.  
  82.             D)   This release is SHAREWARE, if you continue to use this
  83.                  package for more than 3 weeks, you must register it with
  84.                  the author.
  85.  
  86.             The author of the software grants you a license to use this
  87.     software as long as you meet the above conditions.  Any violation of
  88.     the above conditions will result in the termination of your license to
  89.     use this software.  Upon termination of this license for any reason,
  90.     you must stop using the software and destroy all copies of it in your
  91.     possession immediately.  In addition, the author reserves the right to
  92.     cancel your license to use this software at any time for any reason
  93.     that he sees fit.
  94.  
  95.              The author of this software is not liable for damages suffered
  96.     as a result of the improper use, proper use, or inability to use this
  97.     software.  This type of disclaimer is prohibited by law in some states,
  98.     and is therefore void in those states.
  99.  
  100.  
  101.  
  102.  
  103. General Program Characteristics:
  104.  
  105.             The PCBPage door is a door your user s can use to get in touch
  106.     with you rather than through the normal "O"perator Page command.  It
  107.     features Seamless operations with PCBoard 14.5a, support for multiple
  108.     BBS systems, logging of activity to it's own log file, and to the
  109.     caller's log file for the proper node in PCB 14.x systems.
  110.  
  111.             When a User opens the door, he will be prompted as to whether
  112.     he really wanted to page the sysop.  Then asked WHY the page is
  113.     requested.  You will be displayed the reason when paged.  You can
  114.     configure the times you are available for paging each day of the week
  115.     on an hour by hour basis.  This should save you a lot of time not
  116.     answering worthless pages.....
  117.  
  118.  
  119.  
  120.        By: Lance Williams, Kadet PCBoard, (315) 245-3815, USR DS HST/V.32
  121.  
  122.         PCBPage Door                                              Page 2
  123.  
  124.                  Simple Documentation for PCBPage
  125.  
  126.     Since this is a simple door, I'm not going into great detail on the
  127.     setup, if you have any problems, contact me through the PCBHINTS
  128.     Conference on RIME/MetroLink, or call my BBS Directly.  The door is
  129.     simple to set up, and you should not have a problem.
  130.  
  131.  
  132. Configuration File:
  133.  
  134.             Most of the set-up is in the configuration file, which has it's
  135.     own help lines.  But here's a quick run-thru:
  136.  
  137.     Line 1:     INTERRUPT or BIOS, Use BIOS only if INTERRUPT fails to work
  138.     Line 2:     BBS Name
  139.     Line 3:     Door Registration Number (See below for registration info.)
  140.     Lines 4-10: Hours allowed to page, Sunday -> Saturday. (See .CFG file)
  141.     Line 11:    Security levels to override "N" setting in 6-13 above.
  142.  
  143.             Everything after line #11 is ignored, so you can leave it in
  144.     for future reference.
  145.  
  146.  
  147. Other things you need to know:
  148.  
  149.             PCBPage version 2.0+ has been completely re-written in TP 6.0,
  150.     and fully supports multitasking systems.  PCBPage needs a minimum of
  151.     115K of free memory to load.
  152.  
  153.  
  154. Language Text Files and Multilingual Support:
  155.  
  156.             PCBPage 3.0+ now supports multilingual operations, and now uses
  157.     a separate TEXT file, like the PCBTEXT file in PCBoard.  This file is
  158.     just a straight ASCII file you can edit with any ASCII Editor.  The
  159.     file requires 4 lines as follows:
  160.  
  161.     Line 1:    Prompt for "Do you want to page the sysop?" line.
  162.     Line 2:    Prompt for "Why are you paging the sysop?" line.
  163.     Line 3:    Prompt for "Do you wish to force a page?" line.
  164.     Line 4:    Prompt shown when Chat-Mode is initiated by you.
  165.  
  166.             The door will support multilingual files using the same
  167.     filename extension as the PCBTEXT file uses.  These extensions will
  168.     also work in your display screens mentioned below.
  169.  
  170.  
  171. Screens:
  172.  
  173.             There are 3 Sysop created screens for this door that give
  174.     explanations for actions taken.  All Screens have ANSI version with the
  175.     "G" added to the filename, or alternatively, use the @X## color macros
  176.     and use just one file.  Versions 2.0+ support all PCB 14.5 macros in
  177.     the display files.
  178.  
  179.  
  180.        By: Lance Williams, Kadet PCBoard, (315) 245-3815, USR DS HST/V.32
  181.  
  182.         PCBPage Door                                              Page 3
  183.  
  184.     NOPAGE(G):   This screen is displayed if the caller is not allowed to
  185.                  page at this hour.  It is also displayed to users who get
  186.                  the override option if they choose not to override.  Users
  187.                  found in the TCAN file are also shown this file when
  188.                  leaving the door.
  189.  
  190.     NOCHAT(G):   This screen is displayed if the page times out or is user
  191.                  aborted.  It tells the user you were not available for
  192.                  chatting at this time, but to try later.
  193.  
  194.     PAGENOW(G):  This screen is to notify users with security levels listed
  195.                  in line #13 that they have to opportunity to force a page
  196.                  with you (if the time flag in the .CFG file is "N").
  197.  
  198.             Enclosed in this archive are my sample screens. Feel free to
  199.     use them or modify them as you see fit.  If the system does not find
  200.     the appropriate file above in the current directory, it will leave
  201.     display a message of a similar fashion to what the screen should
  202.     display. (Just a one-liner, though...)
  203.  
  204. TCAN and ALWAYS file usage:
  205.  
  206.             If you would like to keep any bothersome users from paging you
  207.     thru the PCBPage door at ANY TIME, all you have to do is to enter his
  208.     name in the "TCAN" file you can maintain in the PCBPage default
  209.     directory.  Any name listed in the "TCAN" file will not be allowed to
  210.     page you.
  211.  
  212.             If you have a user that you would like to be able to page you
  213.     at ANY TIME, independent of the settings in the PCBPAGE.CNF file, then
  214.     enter his name in the "ALWAYS" file.  Any name listed in the "ALWAYS"
  215.     file will be allowed to page you at any time, so be careful of this
  216.     one!
  217.  
  218.             The "TCAN" and "ALWAYS" filenames are hard-coded, so be sure to
  219.     get them right.
  220.  
  221. Log Files:
  222.  
  223.             The door logs all activity to your PCBoard callers log.  It is
  224.     set up to log to the proper file in a multi-node system.  It will also
  225.     send the log output to your printer if PCBoard is so set.
  226.  
  227. Page Bell Setting:
  228.  
  229.             PCBPage has no requirements for your page bell setting.  But,
  230.     if you are like me, you leave it turned off and display a screen to
  231.     your users to use the page door instead.  (I've enclosed my screen as
  232.     SYSPAGE.TXT, and it's designed to be used in your PCBTEXT file at
  233.     record #128, using the "%C:\pcb\gen\syschat.txt" specification. Of
  234.     course, use the path you use to store your display files in, and copy
  235.     the file "SYSCHAT.TXT" to that directory)
  236.  
  237.             I guess that covers the important stuff for now.  Refer to the
  238.  
  239.  
  240.        By: Lance Williams, Kadet PCBoard, (315) 245-3815, USR DS HST/V.32
  241.  
  242.         PCBPage Door                                              Page 4
  243.  
  244.     rest of the documentation for more details.
  245. Door Operations:
  246.  
  247.             This door is called from PCBoard in one of 2 ways, depending on
  248.     if you want a seamless interface (PCB14.5a+ ONLY), or as a regular BBS
  249.     Door.
  250.  
  251. Seamless Door Interface:
  252.  
  253.             You need to be running PCBoard 14.5a or NEWER to operate this
  254.     door as a seamless interface.  A seamless interface is one that has no
  255.     appearance of leaving the PCBoard program to run a door from the user's
  256.     perspective.  (It will not appear seamless on the local screen.)
  257.  
  258.  
  259.     Setting up a SHELL Door (PCBoard 14.5a+ ONLY):
  260.  
  261.             To operate seamlessly, the door MUST be run as a SHELL DOOR
  262.     according to the setups in your PCBSETUP program, DOOR.LST file.  There
  263.     are 3 options for the column SHELL? in the doors setup:
  264.  
  265.             "N" - Do not shell, it's a normal door.  (Do not use this)
  266.             "Y" - Operate as a shell door, no "opening door" prompt.
  267.             "S" - Operate as a shell door, and SWAP PCB to EMS/EXT/Disk.
  268.                   (Use this for limited memory systems.)
  269.  
  270.  
  271.     Using the "Y" or "S" option in the SHELL column of the doors setup will
  272.     operate the door as a shell door, and make it appear as a seamless
  273.     interface.  Even with an "N" the only line displayed will be the "Now
  274.     Loading PAGE....." line from your PCBText file.
  275.  
  276.     Door batch file for SHELL Door:
  277.  
  278.     PAGE door batch file:
  279.  
  280.             e:
  281.             cd \doors\chat
  282.             pcbpage pcbpage.cnf c:\pcb
  283.             c:
  284.             cd \pcb
  285.  
  286.  
  287.     The command line parameters are:
  288.             pcbpage.cnf  <--  Your configuration file for the door.
  289.             c:\pcb       <--  Location of this node's PCBoard data files
  290.                               (PCBOARD.SYS & PCBOARD.DAT)
  291.  
  292.  
  293.     Note that the file does not end with a command to re-run your BOARD.BAT
  294.     file.  This is because you are operating as a shell door.  You don't
  295.     even need an exit, since PCBoard will exit the shell at the end of the
  296.     batch file automatically.  It will even return to the C:\PCB directory
  297.     automatically, but I like to be sure of things.
  298.  
  299.  
  300.        By: Lance Williams, Kadet PCBoard, (315) 245-3815, USR DS HST/V.32
  301.  
  302.         PCBPage Door                                              Page 5
  303.  
  304.  
  305. Normal Door Interface :
  306. (PCBoard 14.0 - 14.5 and all other BBS Programs)
  307.  
  308.             Running under PCBoard as a normal door would only require that
  309.     you add one line to your door batch file to return the system to
  310.     PCBoard after leaving the door (BOARD). IE:
  311.  
  312.     PAGE door batch file:
  313.  
  314.             e:
  315.             cd \doors\chat
  316.             pcbpage pcbpage.cnf c:\pcb
  317.             c:
  318.             cd \pcb
  319.             board
  320.  
  321.  
  322.     The command line parameters are:
  323.             pcbpage.cnf  <--  Your configuration file for the door.
  324.             c:\pcb       <--  Location of this node's PCBoard data files
  325.                               (PCBOARD.SYS & PCBOARD.DAT)
  326.  
  327. Registration:
  328.  
  329.             This door represents many hours of work.  You are allowed to
  330.     use it for a trial period of 30 days to see if it fits your needs.  If
  331.     you continue to use it after that point you are required to register
  332.     it.  The registration is only $15, and considering the time it will
  333.     save you answering useless pages, it's well worth the money.
  334.  
  335.             Send in the registration form in the file REGISTER.TXT to
  336.     register the door.  Send the registration form to:
  337.  
  338.             Lance Williams
  339.             P. O. Box 266
  340.             Camden, NY 13316-0266
  341.  
  342.  
  343.  
  344.  
  345.  
  346.  
  347.  
  348.  
  349.  
  350.  
  351.  
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.  
  359.  
  360.        By: Lance Williams, Kadet PCBoard, (315) 245-3815, USR DS HST/V.32
  361. 
  362.